// Copyright 2007-2015 Chris Patterson, Dru Sellers, Travis Smith, et. al.
//  
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use
// this file except in compliance with the License. You may obtain a copy of the 
// License at 
// 
//     http://www.apache.org/licenses/LICENSE-2.0 
// 
// Unless required by applicable law or agreed to in writing, software distributed
// under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR 
// CONDITIONS OF ANY KIND, either express or implied. See the License for the 
// specific language governing permissions and limitations under the License.
namespace MassTransit.AzureServiceBusTransport
{
    using System;
    using System.IO;
    using System.Threading.Tasks;


    /// <summary>
    /// A context for a message consumed within a message session
    /// </summary>
    public interface MessageSessionContext
    {
        /// <summary>
        /// The SessionId of the session
        /// </summary>
        string SessionId { get; }

        /// <summary>
        /// The session is locked until...
        /// </summary>
        DateTime LockedUntilUtc { get; }

        /// <summary>
        /// Returns the state as a stream
        /// </summary>
        /// <returns></returns>
        Task<Stream> GetStateAsync();

        /// <summary>
        /// Writes the message state from the specified stream
        /// </summary>
        /// <param name="sessionState"></param>
        /// <returns></returns>
        Task SetStateAsync(Stream sessionState);

        /// <summary>
        /// Renews the session lock
        /// </summary>
        /// <returns></returns>
        Task RenewLockAsync();
    }
}